Stream recording events
GET
/recordings/{recordingId}/events/ws
Send recording events over a WebSocket connection. The Browser Client uses this endpoint by default. See WebSocket event streaming for connection and message formats, or use HTTP event collection to send events in batches. Browsers cannot set an Authorization header on WebSocket connections, so pass your public API key in the URL as ?token=your-api-key. The Browser Client adds this parameter automatically. The GET request opens the WebSocket connection; send events as WebSocket messages after connecting.
Authorizations
Public API Key
Public API key for authentication.
Parameters
Path Parameters
recordingId*
The recording ID
Type
Requiredstring
Example
"000e8400-e00b-00d0-a716-446655440000"Format
"uuid"Query Parameters
debug
Enable debug mode
Type
string
Example
"true"contentType
Payload content type. Defaults to application/x-ndjson when omitted.
Type
string
Valid values
"application/x-ndjson""application/ndjson""application/json"Example
"application/x-ndjson"contentEncoding
Optional compression applied to the payload frames. Defaults to identity.
Type
string
Valid values
"gzip""br""zstd"Example
"gzip"Responses
WebSocket upgraded successfully.